home *** CD-ROM | disk | FTP | other *** search
/ Professional Soft Collection 1.02 / Professional Soft Collection 1.02.iso / corscsi2 / disk4 / sapi.do_ / sapi.do
Text File  |  1993-05-14  |  11KB  |  303 lines
  1.  
  2.                   SAPI scanner driver
  3.                    SAPI.EXE
  4.                 October 14, 1992
  5.  
  6. The SAPI scanner driver is a revision 6.10 scanner driver (see REV6.DOC for
  7. more information) providing black and white, gray scale and color scanning
  8. for the current products.
  9.  
  10. The SAPI scanner driver requires the presence of a manufacturer
  11. supplied scanner driver (referred to in this document as SAPI.SYS since the
  12. actual name varies from manufacturer to manufacturer. For example,
  13. Logitech's SAPI driver is called HHSCAND.SYS). SAPI.SYS should be
  14. loaded before the driver.
  15.  
  16. SAPI.EXE also REQUIRES that the scanner hardware be set up for interrupts.
  17. This has NOT been the case for previous scanner drivers.
  18.  
  19. The commands provided by the SAPI scanner driver are listed below in the
  20. example of the /H parameter.
  21.  
  22.     Valid commands:
  23.  
  24.     /Bxxx  = interrupt Buffer size in K (default is 8K, max 63K)
  25.     /Cx    = application Code (1-4)
  26.     /H     = display this Help text
  27.     /?     = display this help text
  28.     /Tx    = do diagnostic Testing (verify communication with scanner)
  29.     /V     = Verbose messages and status displays
  30.     /U     = Unload driver
  31.     /N<dev>= Name of manufacturer's device driver
  32.     /Wx    = Watchdog timeout in seconds
  33.     /0     = Filters (manufacturer specific)
  34.     /1     = Light Sources (manufacturer specific)
  35.  
  36. /N
  37. ==
  38.  
  39. The SAPI driver requires a "helper" driver supplied by the scanner
  40. manufacturer. Normally, this device driver is named "HH$SCAN" (not to be
  41. confused with the DOS file name of something like "SPECTRA.SYS")  The SAPI
  42. 3.1 specification allows for multiple device drivers under sequential names,
  43. such as "HH$SCAN1" or "HH$SCAN2"  The /N command allows the user to specify
  44. the device driver name to look for.
  45.  
  46.  
  47. /W
  48. ==
  49.  
  50. If a watchdog timer is desired to prevent the SAPI driver from locking up
  51. the system in case of a hardware failure, the /W command can be used.  The
  52. default value is 0 - no timer is used.    The timer values can range from 1 to
  53. 255 seconds.
  54.  
  55.  
  56. /0 /1
  57. =====
  58.  
  59. The SAPI 3.1 specification defines some controls that are manufacturer
  60. specific, namely filters and light sources. The /0 and /1 parameters allow
  61. the user to set the text used in the application's scanner-defined user
  62. interface for these controls. The syntax for /0 and /1 is:
  63.  
  64.     /0String_1,String_2[,String_3...]
  65.  
  66. Note that the comma is used to separate the items. Spaces are not allowed.
  67. If you want a space, use an underscore (_) character. If the /0 and /1
  68. parameters are not used, the default text will be sequential numbers starting
  69. with 1.
  70.  
  71. For example, the Niscan Spectra scanner implements the light sources control.
  72. The names of the controls are "Reflective" and "Transparency."  Using the
  73. parameter "/1Reflective,Transparency" sets the text for the Light Sources
  74. options in the application user interface.
  75.  
  76. Under some graphical user interfaces, such as Microsoft Windows, keyboard
  77. shortcuts or accelerators are used to allow the user to quickly navigate
  78. through a dialog box or menu structure. Keyboard shortcuts can be defined
  79. in the /0 and /1 parameters by preceding the accelerator character with an
  80. ampersand (&) character. The accelerators A, H, F, L, S, and U are reserved
  81. by the SAPI driver and should not be used. Depending on the application,
  82. the choices for filters or light sources may be implemented as a list box.
  83. In this case, the accelerators are not used.
  84.  
  85.  
  86. Manufacturer Notes
  87. ==================
  88.  
  89. At this time only the Intel Satisfaxtion, Logitech ScanMan, ScanMan+,
  90. ScanMan 256, Niscan/GS, and Niscan Spectra have been tested with the SAPI.EXE
  91. scanner driver. Any black and white, gray scale, or color scanner that is
  92. compliant with the SAPI specification should work with this driver.
  93.  
  94. The following sections discuss the operaion of the SAPI driver in conbination
  95. with the various supported scanners. Please note that all of the features
  96. listed may not be supported by your application. For example, only the first
  97. four or six resolutions may be available in some applications.
  98.  
  99. INTEL SATISFAXTION
  100. ------------------
  101. This configuration supports the following features:
  102.  
  103.     FEATURE     DRIVER SUPPORT
  104. ======================= ===============
  105. Brightness Settings    Set on scanner
  106. Contrast Settings    N/A
  107. Automatic Brightness    No
  108. Automatic Contrast    No
  109. Resolutions        400x400, 300x300, 200x200, 100x100
  110. Scan Modes        B/W, GS16, GS64, GS256
  111. Halftones        Set on scanner
  112. Enhancements        None
  113. Maximum Scan Area    4.0" x 50.00"
  114. Custom Settings     None
  115.  
  116. Due to the lack of software control over the Logitech and Intel
  117. Satisfaxtion scanners, the SAPI driver can sometimes return invalid
  118. data for a scan. In order to avoid this problem, be sure that the
  119. switch settings on the hand scanner are set to match the selections
  120. made in the application. For these scanners, be sure that the mode
  121. switch is set to 256 BEFORE SAPI.EXE is loaded or gray scale may
  122. not be available as an option within the application.
  123.  
  124.  
  125. LOGITECH SCANMAN
  126. ----------------
  127. This configuration supports the following features:
  128.  
  129.     FEATURE     DRIVER SUPPORT
  130. ======================= ===============
  131. Brightness Settings    Set on scanner
  132. Contrast Settings    N/A
  133. Automatic Brightness    No
  134. Automatic Contrast    No
  135. Resolutions        400x400, 300x300, 200x200, 100x100
  136. Scan Modes        B/W
  137. Halftones        Set on Scanner
  138. Enhancements        None
  139. Maximum Scan Area    2.5" x 50.00"
  140. Custom Settings     None
  141.  
  142. Due to the lack of software control over the Logitech and Intel
  143. Satisfaxtion scanners, the SAPI driver can sometimes return invalid
  144. data for a scan. In order to avoid this problem, be sure that the
  145. switch settings on the hand scanner are set to match the selections
  146. made in the application. For these scanners, be sure that the mode
  147. switch is set to 256 BEFORE SAPI.EXE is loaded or gray scale may
  148. not be available as an option within the application.
  149.  
  150.  
  151. LOGITECH SCANMAN PLUS / SCANMAN 32
  152. ----------------------------------
  153. This configuration supports the following features:
  154.  
  155.     FEATURE     DRIVER SUPPORT
  156. ======================= ===============
  157. Brightness Settings    Set on scanner
  158. Contrast Settings    N/A
  159. Automatic Brightness    No
  160. Automatic Contrast    No
  161. Resolutions        400x400, 300x300, 200x200, 100x100
  162. Scan Modes        B/W
  163. Halftones        Set on Scanner
  164. Enhancements        None
  165. Maximum Scan Area    4.0" x 50.00"
  166. Custom Settings     None
  167.  
  168. Due to the lack of software control over the Logitech and Intel
  169. Satisfaxtion scanners, the SAPI driver can sometimes return invalid
  170. data for a scan. In order to avoid this problem, be sure that the
  171. switch settings on the hand scanner are set to match the selections
  172. made in the application. For these scanners, be sure that the mode
  173. switch is set to 256 BEFORE SAPI.EXE is loaded or gray scale may
  174. not be available as an option within the application.
  175.  
  176.  
  177. LOGITECH SCANMAN 256
  178. --------------------
  179. This configuration supports the following features:
  180.  
  181.     FEATURE     DRIVER SUPPORT
  182. ======================= ===============
  183. Brightness Settings    Set on scanner
  184. Contrast Settings    N/A
  185. Automatic Brightness    No
  186. Automatic Contrast    No
  187. Resolutions        400x400, 300x300, 200x200, 100x100
  188. Scan Modes        B/W, GS16, GS64, GS256
  189. Halftones        Set on Scanner
  190. Enhancements        None
  191. Maximum Scan Area    4.0" x 50.00"
  192. Custom Settings     None
  193.  
  194. Due to the lack of software control over the Logitech and Intel
  195. Satisfaxtion scanners, the SAPI driver can sometimes return invalid
  196. data for a scan. In order to avoid this problem, be sure that the
  197. switch settings on the hand scanner are set to match the selections
  198. made in the application. For these scanners, be sure that the mode
  199. switch is set to 256 BEFORE SAPI.EXE is loaded or gray scale may
  200. not be available as an option within the application.
  201.  
  202.  
  203. NISCAN/GS
  204. ---------
  205. This configuration supports the following features:
  206.  
  207.     FEATURE     DRIVER SUPPORT
  208. ======================= ===============
  209. Brightness Settings    1 to 32
  210. Contrast Settings    1 to 32
  211. Automatic Brightness    No
  212. Automatic Contrast    No
  213. Resolutions        100x100, 200x200, 300x300, 400x400, 50x50, 150x150,
  214.             250x250, 350x350, 25x25, 125x125, 225x225, 325x325,
  215.             75x75, 175x175, 275x275, 375x375,
  216.             Custom [25..400 by 25, Independent]
  217. Scan Modes        B/W, B/W Dither, GS16, GS256
  218. Halftones        Bayer, Coarse Fatting, Fine Fatting, Horizontal Line,
  219.             Vertical Line, Mesh
  220. Enhancements        None
  221. Maximum Scan Area    4.16" x 11.00"
  222. Custom Settings     None
  223.  
  224.  
  225. NISCAN SPECTRA
  226. --------------
  227. When using SAPI.EXE with the Niscan Spectra driver SPECTRA.SYS, include the
  228. following command:
  229.     /1&Reflective,&Transparency
  230.  
  231. This configuration supports the following features:
  232.  
  233.     FEATURE     DRIVER SUPPORT
  234. ======================= ===============
  235. Brightness Settings    1 to 7
  236. Contrast Settings    1
  237. Automatic Brightness    Yes
  238. Automatic Contrast    No
  239. Resolutions        50x50, 100x100, 200x200, 400x400, 75x75, 125x125,
  240.             150x150, 175x175, 225x225, 250x250, 275x275, 300x300,
  241.             325x325, 350x350, 375x375,
  242.             Custom [50..400 by 25, Independent]
  243. Scan Modes        B/W, B/W Dither, GS4, GS16, GS64, GS256, Color 24-bit
  244. Halftones        Bayer, Coarse Fatting, Fine Fatting
  245. Enhancements        None
  246. Maximum Scan Area    3.96" x 5.96"
  247. Custom Settings     Hue [0..4]
  248.             Light Sources [Reflective, Transparency]
  249. NOTE: Not all applications support Custom Settings.
  250.  
  251.  
  252.  
  253. SAPI Messages
  254. =============
  255.  
  256.     Supporting: ???????????
  257.  
  258. This message is displayed upon successful initialization of the SAPI
  259. scanner. The name and model of the scanner found will be displayed.
  260.  
  261.  
  262. SAPI Error Messages
  263. ===================
  264.  
  265.     Manufacturer's device driver `HH$SCAN ' not found.
  266.  
  267. This message is displayed when the scanner driver cannot find the "helper"
  268. driver (provided by the scanner maufacturer). The SAPI scanner
  269. driver requires that this driver be loaded before it can load.
  270.  
  271.  
  272.     Buffer size cannot be larger than 63k
  273.  
  274. This message is displayed when the argument to the /B parameter is greater
  275. than 63.
  276.  
  277.  
  278.     Watchdog timer value cannot be larger than 255
  279.  
  280. This message is displayed when the argument to the /W parameter is greater
  281. than 255.
  282.  
  283.  
  284.     Scanner not responding (do you have the right address?)
  285.  
  286. This message is displayed at initialization time if the scanner driver cannot
  287. successfully communicate with the scanner.
  288.  
  289.  
  290.     Error communicating with manufacturer's driver (????)
  291.  
  292. This message is displayed when an error occurs while sending or receiving
  293. information from the manufacturer supplied driver. An error code is
  294. included in the message to help identify the problem.
  295.  
  296.  
  297.     Scanner hardware not configured for interrupts
  298.  
  299. The SAPI.EXE driver requires interrupts to function. The scanner
  300. hardware interface must be configured to use interrupts. With most
  301. manufacturer's drivers the interrupt can be set with a command line
  302. parameter to the driver (e.g. /I=7, sets interrupt 7).
  303.